You are here: Glossary Notes and Examples

Glossary Notes and Examples

 

Per phone conversation on 02-18-16. For Review Demo 1-A.

Change the use of glossaries and glossary terms. Along with that, create the convention of tablename.fieldname as a standard without any special font or coloring.

  • prefer to only refer to tablename.fieldname as just that. Using the convention of tablename.fieldname, fieldname [tablename] will confuse the reader. Want readers to learn and use just tablename.fieldname as a convention.
  • keep the glossary that has terms as fieldname [tablename]. That glossary allows the user to search or lookup by fieldname only and learn what table(s) that field belongs to and its definition(s).
  • add a glossary for each table that has terms as tablename.fieldname. That glossary will find terms in content, coloring those terms and providing a definition popup.

 

Example:

The term FO_LabInfo.epi_billto_optionsPopulates billto option drop-down list on the episode definition screen. Multidimensional pipe delimited value. Use valid bill to options separated by pipes with leading and trailing pipes. IE: |P|C|I| will be in the content and display as a glossary term.

When a reader either uses search or simply looks in the glossary, they will be able to find the term alphabetically as either just epi_billto_options or FO_LabInfo.epi_billto_optionsPopulates billto option drop-down list on the episode definition screen. Multidimensional pipe delimited value. Use valid bill to options separated by pipes with leading and trailing pipes. IE: |P|C|I|.

 

Same for FO_CDC_Outbound_Filter.ClientCodeClient code or asterisk (*) for all clients. term.